home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / sf33_2.zip / SFHELP.ZIP / SFHELP.DOC < prev    next >
Text File  |  1993-03-03  |  12KB  |  327 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  _____________________________________________________________________________
  18.     ________________                                       ________________
  19.        _____________     DOCUMENTATION FOR: SFHELP.EXE     _____________
  20.           __________  -----------------------------------  __________ 
  21.              _______   Created by Buffalo Creek Software   _______  
  22.                 ____  -----------------------------------  ____   
  23.                   __        Copyright (C) 1987-1993        __
  24.                    _          All rights reserved.         _    
  25.                     _______________________________________
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.                     --------------------------------------
  43.                     ---  Release Date  March 3, 1993  ---
  44.                     --------------------------------------
  45.  
  46.  
  47.  
  48.                                                                     Page 1
  49.  
  50.  
  51. [1]  PURPOSE OF SFHELP.EXE
  52. --------------------------
  53.  
  54.      SFHELP.EXE is a utility designed to create individual help files 
  55. (stored in SPITFIRE.HLP) for the SPITFIRE Bulletin Board System.  The 
  56. very creation and utilization of SFHELP.EXE is with the user in mind.  
  57. When a user needs further instructions about a specific command, he/she
  58. need not go through the burden of having to read over the entire HELP
  59. file just to find the help they need for a certain command.  The very 
  60. essence of SFHELP.EXE is to streamline and expediate the HELP process 
  61. for the new user as well as the experienced user who may be using a
  62. command with which he/she is unfamiliar.
  63.  
  64.  
  65. [2]  USE OF SFHELP.EXE
  66. ----------------------
  67.  
  68.      To boot the utility, simply type in:
  69.  
  70.                                  C>SFHELP
  71.  
  72.      You will then get to the screen where a help-file will be displayed and 
  73. the commands to operate SFHELP will appear. 
  74.  
  75.      The screen will look like this:
  76.  ____________________________________________________________________________
  77.  
  78.                    ╒═════════════════════════════════════════╕ 
  79.                    │    - MAINTAIN SPITFIRE HELP FILE -      │  
  80.                    │         BUFFALO CREEK SOFTWARE          │ 
  81.                    │            913 - 39th Street            │ 
  82.                    │       West Des Moines, Iowa 50265       │ 
  83.                    │ Copyright (C) by Mike Woltz, 1987-1993  │   
  84.                    ╘═════════════════════════════════════════╛
  85.  
  86.  
  87. Record Number [(helpfile #) of (maximum helpfiles)]  "Name Of Command"
  88.  
  89. The purpose for SFHELP.EXE is to break down Help Menus into
  90. individual help screens for any command about which a user
  91. may have a question.  It is more efficient than one large
  92. help menu and saves time on the user's behalf.
  93.  
  94.  
  95.        <+> Next Help Record  <-> Previous Help Record  <A>dd Help Record
  96.              <G>et Help Record   <C>hange Help Record   <Q>uit
  97.  
  98.                                Enter Selection:
  99.  
  100.  ____________________________________________________________________________
  101.  
  102.      Be certain to have SPITFIRE.HLP in the same directory/path as 
  103. SFHELP.EXE, otherwise you have no help record data when you boot this 
  104. utility.  When finished, be certain that SPITFIRE.HLP is in the same 
  105. directory/path as SPITFIRE.EXE!
  106.  
  107.                                                                      Page 2
  108.  
  109.  
  110. [3]  COMMANDS EXPLAINED
  111. -----------------------
  112.  
  113.  
  114.      <+> Next Help Record
  115.          This will allow you to view the help record following the one that
  116.          is currently being displayed on the screen.
  117.  
  118.  
  119.      <-> Previous Help Record
  120.          This allows you to back up one help record from the record currently
  121.          displayed.
  122.  
  123.  
  124.      <A> Add Help Record
  125.          This command enables you to create a new help record that will be
  126.          immediately appended to the tail end of the existing help file.
  127.          
  128.          IMPORTANT!:  Do NOT accumulate more than 50 total help records in
  129.          SPITFIRE.HLP!  (For more on this, refer to Section 4 of this file.)
  130.          
  131.          When you enter a help record, you are restricted to 6 lines with 60
  132.          characters per line.  You must use a ";" to indicate a blank line.
  133.          A "\" is used to indicate no line.
  134.  
  135.  
  136.      <G> Get Help Record
  137.          This allows you to go to a specific help record.  When you enter
  138.          this command, the program will ask for the record's number you wish
  139.          to see.  Simply key in the record number and SFHELP will take you
  140.          directly to that record.
  141.  
  142.  
  143.      <C> Change Help Record
  144.          This command can be used for a dual purpose.  It can be used to
  145.          change a record, should you find a mistake in it, or it can be used
  146.          to overwrite an old help record by entering a new record.
  147.          
  148.          IMPORTANT!:  Do NOT combine or exchange help records!  (For more on
  149.          this, refer to Section 4 of this file.)
  150.  
  151.  
  152.       <Q> Quit
  153.           This command will dump you back to DOS.
  154.           
  155.  
  156. [4]  CURSOR CONTROL
  157. -------------------
  158.      
  159.       When adding or editing a help record the entire six line help screen
  160. is displayed.  Several options are available for positioning the cursor 
  161. around in the help work area.  These are:
  162.  
  163.    Left Arrow Key  - This will move the cursor left 1 character position.
  164.    
  165.    Right Arrow Key - This will move the cursor right 1 character position.   
  166.  
  167.                                                                      Page 3
  168.  
  169.  
  170.  
  171.    Up Arrow Key    - This will move the cursor up 1 line and place the
  172.                      cursor at the beginning of that line.
  173.  
  174.    Down Arrow Key  - This will move the cursor down 1 line and place the 
  175.                      cursor at the beginning of that line.
  176.                      
  177.    End Key         - This will move the cursor to the end of the current line.
  178.    
  179.    Home Key        - This will move the cursor to the beginning of the current
  180.                      line.
  181.                      
  182.    Backspace Key   - This will delete the character to the left of the current
  183.                      cursor position.
  184.                      
  185.    Del Key         - This will delete the character in the current cursor
  186.                      position.
  187.                      
  188.    Escape Key      - When editing a record this will terminate the editing and
  189.                      return you to the main sfhelp screen.
  190.                      
  191.    Insert Key      - The insert key can be used to activate and deactivate the
  192.                      the insert mode.  The present mode is always displayed in 
  193.                      the lower left hand portion of the screen.  It will be 
  194.                      displayed either as Insert Active or Insert Inactive.   
  195.  
  196.  
  197. [5]  HELP RECORD INFORMATION
  198. ----------------------------
  199.   
  200.      There are 3 basic rules that must ALWAYS be followed when working with
  201. SFHELP.EXE!  These rules MUST be followed at all costs.  To do otherwise is
  202. only inviting disaster in this arena of SPITFIRE.
  203.  
  204.  
  205.      [A]  You CANNOT accumulate more than 55 help records!
  206.      ------------------------------------------------------
  207.      To do so is not only useless, but hazardous to the efficiency of
  208.      SPITFIRE!  There are only 55 commands to deal with in SPITFIRE, so
  209.      it stands to reason that there is no need to add help records for 
  210.      commands that do not even exist.
  211.      
  212.      If you attempt to add a new help record and 55 already exist, the  
  213.      message, "The maximum number of records are already written!" is
  214.      displayed to the screen.
  215.  
  216.  
  217.      [B]  You CANNOT combine help records!
  218.      -------------------------------------
  219.      First off, combining help records defeats the entire purpose of SFHELP.
  220.      If one combines the <P>age the Sysop help record with the <C>omment to
  221.      Sysop help record, one is only succeeding in confusing the new user
  222.      and frustrating the experienced user.
  223.  
  224.                                                                      Page 4   
  225.  
  226.      [C]  You CANNOT exchange help records!
  227.      --------------------------------------
  228.      Exchanging the help records can cause unparalleled pandemonium for your
  229.      help records.  Each help record is affixed a numeric designation that
  230.      SPITFIRE will look for when asked to display the command explanation 
  231.      held in SPITFIRE.HLP.  If one has exchanged the help record for 
  232.      "<D>ownload a File" with the help record for "<V>iew a Text File", 
  233.      (and vice-versa) imagine the utter confusion of the user who asks for 
  234.      information on downloading and only succeeds in getting a discourse on 
  235.      viewing textfiles!
  236.  
  237.      IMPORTANT!
  238.      ---------- 
  239.      The following section lists the all of SFHELP's numeric designations 
  240.      coupled with their respective help record descriptions.  If you are ever
  241.      in doubt as to what help file belongs with which help record number, be
  242.      certain to consult Section 5 to insure complete accuracy!
  243.  
  244.  
  245.  
  246. [5]  RECORD CONFIGURATION
  247. --------------------------
  248.      
  249. _____________________________________________________________________________
  250.  
  251.  
  252.          [1]  Page Sysop  
  253.          [2]  Goodbye & Log Off
  254.          [3]  Expert Level     
  255.          [4]  Go To Sysop Section 
  256.          [5]  Sysop Configurable Feature - File Menu
  257.          [6]  Sysop Configurable Feature - Main Menu
  258.          [7]  Change File Area
  259.          [8]  List Files      
  260.          [9]  Erase A File    
  261.         [10]  Download A File 
  262.         [11]  Read A Textfile 
  263.         [12]  Jump/File Section To Message Section                           
  264.         [13]  Quit To Main Menu    
  265.         [14]  View A file archive
  266.         [15]  New Files  
  267.         [16]  File Description Text Search 
  268.         [17]  Find A File           
  269.         [18]  ? Help 
  270.         [19]  Help With File Protocols      
  271.         [20]  Upload A File                 
  272.         [21]  Jump/Main Menu To Message Section
  273.         [22]  Jump - Main Menu To File Section
  274.         [23]  Bulletins                    
  275.         [24]  Comment To Sysop 
  276.         [25]  List Users
  277.         [26]  Locate A User
  278.         [27]  Initial Welcome
  279.         [28]  System Information
  280.         [29]  Newsletter
  281.         [30]  Your Statistics
  282.  
  283.                                                                     Page 5
  284.  
  285.  
  286.  
  287.         [31]  Other BBS Names & Numbers
  288.         [32]  Add To BBS List
  289.         [33]  Questionnaire Menu
  290.         [34]  Browse Messages
  291.         [35]  Change Message Conference
  292.         [36]  Read Messages
  293.         [37]  Hurry-Scan Messages
  294.         [38]  Enter A Message
  295.         [39]  Your Messages
  296.         [40]  Message Text Search
  297.         [41]  Jump/Message Section to File Menu
  298.         [42]  Jump/Message Section to Main Menu
  299.         [43]  Add To Batch
  300.         [44]  View Tagged/Queued List
  301.         [45]  Begin File Transfer
  302.         [46]  Remove File Batch Queue
  303.         [47]  Start New Batch Queue
  304.         [48]  Quit Batch
  305.         [49]  Batch Help
  306.         [50]  SPITFIRE Doors
  307.         [51]  Non-Stop Message Capture
  308.         [52]  Sysop Configurable Feature - Message Menu
  309.         [53]  Alter Message Conference Queue
  310.         [54]  Shuffle Files
  311.         [55]  LAKOTA (QWK Mail System)
  312.         
  313. _____________________________________________________________________________
  314.  
  315.  
  316.      IMPORTANT!
  317.      ----------
  318.      Keep this list handy in all circumstances when you are using SFHELP.EXE
  319. to edit the SPITFIRE.HLP file to your taste.  Remember, a misplaced or
  320. erroneous help file could truly bungle your SPITFIRE.HLP file and add to
  321. the user's frustration and confusion.
  322.  
  323.      If you have any problems or questions about SFHELP.EXE or any other
  324. SPITFIRE utility, feel free to contact Buffalo Creek BBS (515-225-8496).  We
  325. will try to answer any questions pertaining to this utility (and others) and
  326. work with you towards solving your problem.  Thank you for using SPITFIRE!
  327.